Cluster Name

Request Structure


Endpoint:	`/kube-get-secret-yaml`
Type:	`POST`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/kube-get-secret-yaml?gwsource=external` To understand the elements of the sample URL, click here.
Headers:
Content-Type:	application/json

Table 1. Input Parameter
Name	Description
sessionId `Header`	(Mandatory) A unique identifier assigned to a user's session upon successful authentication. The session ID remains valid until it expires, and it can contain alphanumeric characters. Type: String Constraints: The session ID is used when username and password are not provided. Example: `A1B2c3d4E5F6`
gwsource `Header`	(Mandatory) Source from which the request is triggered. Type: String Example: `DataCenterA`
payload `Body`	(Mandatory) Input data for request body in application/json format. For payload details, see Payload section.

Payload

Table 2. Input Parameter
Name	Description
isDefaultServiceAccountDownload `Boolean`	(Optional) Downloads the default service account credentials. The values can be: true false
clusterName `String`	(Optional) Retrieves or downloads the secret using the data from cluster information. Any string matches regex "^[A-Za-z0-9-_.\|!\\s][A-Za-z0-9-_. \|!]*$\|^$"
authenticationURL `String`	(Mandatory) This URL is referenced in the secret YAML content, and the orchestrator uses this URL to communicate with AppViewX.

Response Structure

Table 3. Response
Name	Description
name	Name of the secret.
namespace	Namespace in which the secret is created.
type	Type of secret.
data	Encoded data fields containing sensitive information such as client ID, client secret, and AppViewX environment URL.


Name	Description
response `String`	The response contains the attributes needed to create namespace, add Helm repo, and install cert-orchestrator plugin for easy onboarding.
message `String`	Success message or failure description in case of error.
appStatusCode `String`	Application specific status code for the response. Will be non-null for failure response.
tags	More info in case of failure response.

Sample Request/Response

Use case: Generate command to generate or download the secret YAML using cluster name.

Request URL

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/kube-get-secret-yaml?gwsource=external

Sample Request

Content type: application/json Username: <> Password: <>
{
    "payload": {
        "isDefaultServiceAccountDownload": false,
        "serviceAccountName": "kube-svc-account",
        "authenticationURL": "url"
    }
}

Sample Response

---
apiVersion: "v1"
kind: "Secret"
metadata:
name: "appviewx-auth"
namespace: "crypto-mesh"
type: "Opaque"
data:
CLIENT_ID: "ZTE0ZmRlOGMtMTg0ZC00ZmRkLTk1MTItNGQzYzZmYjI3NmQz"
CLIENT_SECRET: "ZVE2clB1QkdIOCpnTTFWUmMzeVZ2VHZQbUNwI3pBYzY="
APPVIEWX_ENV_URL: "dXJs"

Reference

Understanding the sample URL: This section provides an explanation of each component of the sample URL structure used in API requests. For quick reference, this section is referenced in all the API topics as Reference in this guide.

IP/HostName/TenantName: Replace with the actual IP address, hostname, or tenant name based on the specific configuration in AppViewX.
- IP: A unique identifier assigned to each device connected to a computer network that uses the Internet Protocol for communication
  The IP address will be included in the endpoint URL for an on-prem deployment.
- HostName: A human-readable label assigned to a device (host) on a network
  The hostname will be included in the endpoint URL for an on-prem deployment.
- TenantName: An identifier label for a tenant given to indicate which tenant's data the API request will access/modify
  The tenant name will be included in the endpoint URL for a SaaS deployment.
GWPORT: AppViewX gateway port
A gateway port refers to a network port through which data is sent and received to communicate with a gateway in an on-prem deployment.
Example: 31443
avxapi: Path parameter value (static) that is part of the endpoint's URL
Endpoint: Endpoint of the API, for example: execute-hook
gwsource: Source or origin of a gateway, for example: external.

What's New

Upgrade Cluster Command